#pragma once
#include "stdafx.h"
//-------------------------------------------------------------------------------------------------
//ProcParam.h  - Abstract Base Class of Parameter for Image Processing Steps           
//-------------------------------------------------------------------------------------------------
//FreeBSD License
//Copyright 2012 Will Stott All rights reserved.
//
//Redistribution and use in source and binary forms, with or without modification, are
//permitted provided that the following conditions are met:
//
//   1. Redistributions of source code must retain the above copyright notice, this list of
//      conditions and the following disclaimer.
//
//   2. Redistributions in binary form must reproduce the above copyright notice, this list
//      of conditions and the following disclaimer in the documentation and/or other materials
//      provided with the distribution.
//
//THIS SOFTWARE IS PROVIDED BY Will Stott ``AS IS'' AND ANY EXPRESS OR IMPLIED
//WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Will Stott OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//The views and conclusions contained in the software and documentation are those of the
//authors and should not be interpreted as representing official policies, either expressed
//or implied, of Will Stott.
//
//----Authors--------------------------------------------------------------------------------------
//created by: will.stott@ucl.ac.uk Feb 2012
//
//----Comments-------------------------------------------------------------------------------------
//
//-------------------------------------------------------------------------------------------------
#ifdef IMAGEEXPTLIB_EXPORTS
#define IMAGEEXPTLIBAPI __declspec(dllexport)
#else
#define IMAGEEXPTLIBAPI __declspec(dllimport)
#endif

#include <string>

class IMAGEEXPTLIBAPI ProcParam
{
public:
	static const int		  Invalid = -1;
	static const char * const ProcParam::BadName;
	static const char * const ProcParam::BadValue;

	static const char * const XmlProcParam;
	static const char * const attribParamName;
	static const char * const attribOutputParamNameResult;	//only for output
	static const char * const attribOutputParamNameScore;	//only for output, analysis
	static const char * const attribParamIndex;
	static const char * const attribParamType;
	static const char * const attribParamValue;

	enum Direction 
	{
		input = 0,
		output
	};

public:
	static ProcParam *CreateProcParam(const char *ParamType, const char *Name, int Index, ProcParam::Direction dir, const char *Value);
	static ProcParam *CreateProcParam(ProcParam* param);

	virtual ~ProcParam(void);

	virtual const char *			GetType() = 0;
	virtual bool					IsValid() = 0;

	ProcParam::Direction	GetDirection() { return _dir; }
	const char *			GetName() {  return  _name.c_str(); }   //return value even if it is invalid
	int						GetIndex() { return _index; }			//return value even if it is invalid, index in the called function's parameter list, NOT position in ProcParams::_Params[pos] 
	const char *			GetValueStr() { return _valStr.c_str(); }
protected:
	ProcParam();
	ProcParam(const ProcParam* param);
	ProcParam(int Index, const char *Name, ProcParam::Direction dir);
protected:
	int			_index;
#pragma warning(disable:4251)
	std::string _name;
	std::string _valStr;
#pragma warning(default:4251)
private:
	bool		_error;
	ProcParam::Direction _dir;
};

//-------------------------------------------------------------------------------------------------
//			E N D   O F   F I L E
//-------------------------------------------------------------------------------------------------

